GetNameList {Frame}

GetNameList

Syntax

SapObject.SapModel.PropFrame.GetNameList

VB6 Procedure

Function GetNameList(ByRef NumberNames As Long, ByRef MyName() As String, Optional ByVal PropType As eFramePropType) As Long

Parameters

NumberNames

The number of frame section property names retrieved by the program.

MyName

This is a one-dimensional array of frame section property names. The MyName array is created as a dynamic, zero-based, array by the API user:

Dim MyName() as String

The array is dimensioned to (NumberNames - 1) inside the SAP2000 program, filled with the names, and returned to the API user.

PropType

This optional value is one of the following items in the eFramePropType enumeration.

SECTION_I = 1

SECTION_CHANNEL = 2

SECTION_T = 3

SECTION_ANGLE = 4

SECTION_DBLANGLE = 5

SECTION_BOX = 6

SECTION_PIPE = 7

SECTION_RECTANGULAR = 8

SECTION_CIRCLE = 9

SECTION_GENERAL = 10

SECTION_DBCHANNEL = 11

SECTION_AUTO = 12

SECTION_SD = 13

SECTION_VARIABLE = 14

SECTION_JOIST = 15

SECTION_BRIDGE = 16

SECTION_COLD_C = 17

SECTION_COLD_2C = 18

SECTION_COLD_Z = 19

SECTION_COLD_L = 20

SECTION_COLD_2L = 21

SECTION_COLD_HAT = 22

SECTION_BUILTUP_I_COVERPLATE = 23

SECTION_PCC_GIRDER_I = 24

SECTION_PCC_GIRDER_U = 25

SECTION_BUILTUP_I_HYBRID = 26

SECTION_BUILTUP_U_HYBRID = 27

If no value is input for PropType, names are returned for all frame section properties in the model regardless of type.

Remarks

This function retrieves the names of all defined frame section properties of the specified type.

The function returns zero if the names are successfully retrieved; otherwise it returns nonzero.

VBA Example

Sub GetFramePropNames()

'dimension variables

Dim SapObject as cOAPI

Dim SapModel As cSapModel

Dim ret As Long

Dim NumberNames As Long

Dim MyName() As String

'create Sap2000 object

Set SapObject = CreateObject("CSI.SAP2000.API.SapObject")

'start Sap2000 application

SapObject.ApplicationStart

'create SapModel object

Set SapModel = SapObject.SapModel

'initialize model

ret = SapModel.InitializeNewModel

'create model from template

ret = SapModel.File.New2DFrame(PortalFrame, 2, 144, 2, 288)

'get frame section property names

ret = SapModel.PropFrame.GetNameList(NumberNames, MyName)

'close Sap2000

SapObject.ApplicationExit False

Set SapModel = Nothing

Set SapObject = Nothing

End Sub

Release Notes

Initial release in version 11.02.

Builtup I Hybrid and Builitup U Hybrid added with Version 15.0.0.

See Also